/*
 * Copyright 2017 - 2025 the original author or authors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see [https://www.gnu.org/licenses/]
 */

package infra.app.jdbc.metadata;

import org.jspecify.annotations.Nullable;

import javax.sql.DataSource;

/**
 * Provide a {@link DataSourcePoolMetadata} based on a {@link DataSource}.
 *
 * @author Stephane Nicoll
 * @author <a href="https://github.com/TAKETODAY">Harry Yang</a>
 * @since 4.0
 */
@FunctionalInterface
public interface DataSourcePoolMetadataProvider {

  /**
   * Return the {@link DataSourcePoolMetadata} instance able to manage the specified
   * {@link DataSource} or {@code null} if the given data source could not be handled.
   *
   * @param dataSource the data source
   * @return the data source pool metadata
   */
  @Nullable
  DataSourcePoolMetadata getDataSourcePoolMetadata(DataSource dataSource);

}
